Skip to content

docs: sync CLAUDE.md and README with current source#111

Merged
UtkarshBhardwaj007 merged 1 commit into
mainfrom
docs/refresh-cli-docs
May 4, 2026
Merged

docs: sync CLAUDE.md and README with current source#111
UtkarshBhardwaj007 merged 1 commit into
mainfrom
docs/refresh-cli-docs

Conversation

@UtkarshBhardwaj007

Copy link
Copy Markdown
Member

Summary

  • README: documents dot logout, surfaces deploy flags --private, --contracts, --no-build, --no-contract-build in the main flags list, and collapses the duplicated CI flags table.
  • CLAUDE.md: fixes the withSpan overload count typo (was "2-arg + 4-arg", actual signatures are (op, name, fn) and (op, name, attributes, fn)) and notes which commands pass watchdog / hardExit to runCliCommand.
  • src/utils/deploy/storage.ts: corrects a stale module-level docstring that claimed jsMerkle: true is forced. The wrapper deliberately does NOT set that flag (Kubo binary path), matching the in-function comment and the CLAUDE.md invariant.

No runtime behaviour changes. No changeset, since nothing user-visible shipped beyond doc accuracy.

Test plan

  • pnpm format:check
  • npx tsc --noEmit
  • pnpm test

README:
- Add `dot logout` command section.
- Document deploy flags `--private`, `--contracts`, `--no-build`,
  and `--no-contract-build` in the main flags list. Collapse the
  duplicated CI flags table into a tighter checklist.
- Update headless-mode summary so `--private` and `--contracts` are
  listed as independently optional alongside `--modable`.

CLAUDE.md:
- Fix `withSpan` overload count (was "2-arg + 4-arg", actual is
  "3-arg + 4-arg"). Spell out the signatures inline.
- Note which commands pass `watchdog` and `hardExit` to
  `runCliCommand`.

src/utils/deploy/storage.ts:
- Fix stale module-level docstring that claimed we force
  `jsMerkle: true`. The wrapper deliberately does NOT set that flag
  (Kubo binary path), matching the in-function comment and the
  CLAUDE.md invariant.

No runtime behaviour changes; no changeset.
@github-actions

github-actions Bot commented May 4, 2026

Copy link
Copy Markdown
Contributor

Dev build ready — try this branch:

curl -fsSL https://raw.githubusercontent.com/paritytech/playground-cli/main/install.sh | VERSION=dev/docs/refresh-cli-docs bash

@UtkarshBhardwaj007 UtkarshBhardwaj007 merged commit 1f64f04 into main May 4, 2026
16 checks passed
@UtkarshBhardwaj007 UtkarshBhardwaj007 deleted the docs/refresh-cli-docs branch May 4, 2026 10:48
@github-actions

github-actions Bot commented May 4, 2026

Copy link
Copy Markdown
Contributor

E2E Test Pass · ✅ PASS

Tag: e2e-ci-pr · Branch: docs/refresh-cli-docs · Commit: f3cc7d5 · Run logs

Cell Result Time
pr-deploy-foundry ✅ PASS 1m49s
pr-mod ✅ PASS 1m16s
pr-deploy-frontend ✅ PASS 6m34s
pr-init-session ✅ PASS 1m12s
pr-preflight ✅ PASS 2m38s
pr-install ✅ PASS 0m35s
${{ matrix.cell }} ⏭️ SKIP 0m00s
${{ matrix.cell }} ⏭️ SKIP 0m00s

Sentry traces: view spans for this run

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant